/*
 *  Copyright (C) 2010 Glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.builder;

import org.balisunrise.annotation.util.EditorUtilities;
import org.balisunrise.common.Editor;

/**
 * Esta Inteface é responsável pela construção dos editores das entidades.
 *
 * @author Glauco
 *
 * @see org.balisunrise.annotation.Editor
 * @see org.balisunrise.annotation.util.EditorUtilities
 * @see org.balisunrise.common.Editor
 */
public interface EditorBuilder {

    /**
     * Cria uma editor a partir de uma classe de uma entidade e o alias
     * do editor.<br>
     * Este método cria o Messenger, o Painel e as ações subordinados a ele.
     *
     * @param entityClass Classe de uma entidade.
     * @param alias Alias para construir o editor.
     * @return Um Editor de entidades.
     *
     * @see org.balisunrise.annotation.Editor
     */
    public Editor create(Class entityClass, String alias)
            throws BuilderException;

    /**
     * Cria um Editor a partir do EditorUtilities.<br>
     * Este método cria o Messenger, o Painel e as ações subordinados a ele.
     *
     * @param editorUtilities Utilitário para construção do Editor
     * @return Um Editor de entidades.
     *
     * @see org.balisunrise.annotation.util.EditorUtilities
     */
    public Editor create(EditorUtilities editorUtilities)
            throws BuilderException;
}
